<meta charset="utf-8">
(#) Unconditional Logging Calls

!!! WARNING: Unconditional Logging Calls
   This is a warning.

Id
:   `LogConditional`
Summary
:   Unconditional Logging Calls
Note
:   **This issue is disabled by default**; use `--enable LogConditional`
Severity
:   Warning
Category
:   Performance
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   1.1.0 (February 2015)
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/LogDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/LogDetectorTest.kt)

The `BuildConfig` class provides a constant, `DEBUG`, which indicates
whether the code is being built in release mode or in debug mode. In
release mode, you typically want to strip out all the logging calls.
Since the compiler will automatically remove all code which is inside a
`if (false)` check, surrounding your logging calls with a check for
`BuildConfig.DEBUG` is a good idea.

If you **really** intend for the logging to be present in release mode,
you can suppress this warning with a `@SuppressLint` annotation for the
intentional logging calls.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/LogExample.kt:7:Warning: The log call Log.i(...) should be
conditional: surround with if (Log.isLoggable(...)) or if
(BuildConfig.DEBUG) { ... } [LogConditional]
    Log.i(TAG, "message" + m) // string is not constant; computed each time
    -------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/LogExample.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
import android.util.Log

const val TAG = "tag1"

class LogExample {
    fun test(m: String) {
        Log.i(TAG, "message" + m) // string is not constant; computed each time
    }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/LogDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("LogConditional")
  fun method() {
     d(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("LogConditional")
  void method() {
     d(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection LogConditional
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="LogConditional" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'LogConditional'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore LogConditional ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>